home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / search22.zip / SEARCH.DOC < prev    next >
Text File  |  1991-12-11  |  15KB  |  343 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                               WORD  SEARCH
  7.  
  8.                                   v2.2
  9.  
  10.                               PCBoard 14.x
  11.  
  12.                                    by
  13.  
  14.                               Al Lawrence
  15.  
  16.                             Sunrise-80  BBS
  17.                             (404) 256-9525
  18.  
  19.  
  20.  
  21.  
  22.                                 OVERVIEW
  23.                                 ________
  24.  
  25.  
  26.    Word Search is a computerized adaptation of the type of puzzles normally
  27.    found in puzzle books, newspapers and magazines. Given a list of words, 
  28.    you must find them in the letter grid. They are hidden horizontally, 
  29.    vertically, diagonally, in both normal and reverse order spelling.
  30.  
  31.  
  32.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  33.          created in the directory you run the door from.
  34.  
  35.  
  36.  
  37.                               INSTALLATION
  38.                               ____________
  39.  
  40.  
  41.    Installation is fairly easy and straight-forward. The following steps and
  42.    examples should have you up and running in a very short period of time.
  43.    It is assumed that you are familiar with setting up DOORS on your system.
  44.    To this end, only examples of the configuration file and Door batch file
  45.    are described.
  46.  
  47.       1) Create a directory to hold all SEARCH files
  48.  
  49.       2) Unzip SEARCHxx.ZIP into the the above directory
  50.  
  51.          NOTE: BRUN45.EXE is not included but is required !!!
  52.  
  53.       3) Create a configuration file, with a name of your choice, or
  54.          modify the supplied SEARCH.CFG file. A description follows:
  55.  
  56.             **                       Location of system file (See Below)
  57.             SUNRISE-80 BBS           Your BBS Name
  58.             Al                       Sysop's First nameAP
  59.  
  60.             Lawrence                 Sysop's Last Name
  61.  
  62.             00000000                 Registration Number
  63.  
  64.     !   #   2                        Maximum # of Games per day
  65.                                      (Sysop gets 99 in Registered version ONLY!)
  66.  
  67.             50                       Number of Top Score entries.
  68.                                      Minimum = 10, Maximum = 99.
  69.  
  70.         #   NONE                     Drive:\Path\Filename to contain the
  71.                                      Top Score Bulletin or enter NONE
  72.                                      for NO Bulletin creation.
  73.  
  74.         #   NONE                     Drive:\Path\Filename to contain the
  75.                                      Top Score Bulletin (Color) or enter NONE
  76.                                      for NO Bulletin creation.
  77.  
  78.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  79.                                      2 = Display ADOPT-A-DOOR message
  80.  
  81.         #   2                        Keyboard timeout value in Minutes
  82.  
  83.  
  84.         #   2                        Max. time to play each word (1-4 Minutes)
  85.  
  86.         #   5                        Number of words to hide in the grid(1-9)
  87.  
  88.     !   #   0                        Time Allowed in Door
  89.                                      (Sysop = Time Remaining - REG. VERSION)
  90.  
  91.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  92.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.  
  102.  
  103.           ** = Replace with ONE of the following:
  104.  
  105. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  106. C:\PCB\USERS.SYS                <- For PCBoard systems using USERS.SYS
  107. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  108. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  109.                                    (Note:DOOR.SYS must be in SAME directory)
  110. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  111. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  112. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  113. C:\BBS\CHAIN.TXT                <- For WWIV systems                
  114.  
  115.            # = Requires registration to change to a different value.
  116.            ! = See "Plays Per Day" Below
  117.  
  118.  
  119.                NOTE: There are NO Blank Lines in the Config File!!
  120.  
  121.  
  122.       4) Create a batch file or modify the PAIR3 file supplied. A
  123.          description of this file follows:
  124.  
  125.             ECHO off
  126.             cd\PCB\DOORS\SEARCH       Location of Search files
  127.             SEARCH SEARCH.CFG         EXE filename and CNF filename (Name
  128.                                       used in creating file in #3 above)
  129.             CD\PCB
  130.             BOARD
  131.  
  132.  
  133.        5) When running in more than one node, be sure to supply a
  134.           different configuration name for each node (your choice of name).
  135.  
  136.  
  137.                    
  138.                           PLAYS Per DAY/DOOR Time
  139.                           _______________________
  140.  
  141.       Plays Per Day and Door Time can be controlled several ways:
  142.  
  143.       (1) You can use the Games Per Day, singular option, in the config
  144.           file above. This option, will affect ALL callers whose Security
  145.           Level is NOT defined in any of the 10 optional Security Level/
  146.           Plays Per Day entries in the config file.
  147.  
  148.       (2) You can use the Door Time, singular option, in the config file
  149.           above. This option, will affect ALL callers whose Security
  150.           Level is NOT defined in any of the 10 optional Security Level/
  151.           Plays Per Day/Door Time entries in the config file.
  152.  
  153.       (3) You can restrict the number of games a specific Security Level
  154.           will be allowed to play per day or REWARD specific Levels with 
  155.           more Plays Per Day. 
  156.  
  157.           Likewise, you can restrict the Play time for a specific Security
  158.           Level or REWARD specific Levels with more Door Time.
  159.  
  160.           These options are handled by the use of the 10 config 
  161.           entries (000=00/00). 
  162.           
  163.           The format of each entry is as follows:
  164.  
  165.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  166.                      where =  is a constant and MUST be included
  167.                      where YY is the # of games per day (must be 2 digits)
  168.                      where / is a constant and MUST be included
  169.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  170.           
  171.           If the callers Security Level is NOT defined, his/her Plays Per
  172.           Day and Door Time will be controlled by the values in items
  173.           (1) and (2), above, respectively..
  174.  
  175.           You may define up to 10 Security Levels. All unused entries must
  176.           be defined as   000=00/00
  177.         --------------------------------------------------------------------
  178.           Example: Suppose you had 3 Security Levels defined on your BBS as
  179.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  180.           wanted to set Plays Per Day as :     Subscriber=5
  181.                                            Visiting Sysop=2
  182.                                                   CoSysop=3
  183.                                                    Friend=10 
  184.           
  185.           and Door Time as follows:     Subscriber=30 minutes
  186.                                     Visiting Sysop=20 minutes
  187.                                            CoSysop=10 minutes 
  188.                                             Friend=remaining call time
  189.                                
  190.  
  191.           You would set the Individual "Games per Day" config entry to 1 and 
  192.           the individual "Door Time" to 5 minutes (these would be the 
  193.           default number of games and default Time for all Security Levels
  194.           other than 20,30 or 40... make them any number you want). Next you
  195.           would replace 4 of the Security Level entries as :  020=05/30                                               
  196.                                                               030=02/20
  197.                                                               040=03/10
  198.                                                               090=10/0
  199.  
  200.  
  201.  
  202.     
  203.  
  204.                                WORD FILE
  205.                                _________
  206.  
  207.      In the unregistered version of Word Search there is an interenal word
  208.      list, containing 15 words. When you register the door, the program will
  209.      access the SEARCH.QUE file, which will initially contain 200 words. You
  210.      are free to create your own list or modify the supplied list (using any 
  211.      word processor or editor). The length of each word must not exceed 9 
  212.      characters and the name of the file must be SEARCH.QUE.
  213.  
  214.      The number of puzzles contained in the file is important. There must be 
  215.      enough puzzles in the file equal to or greater than the following formula:
  216.  
  217.               MAXIMUM GAMES per DAY  x  NUMBER WORDS to HIDE + 10
  218.  
  219.      For example: if your configuration file was setup to allow the caller to
  220.      play 5 games per day and to hide 9 words, then the minimum number of
  221.      words you would have to have in the SEARCH.QUE file would be 55.
  222.  
  223.      NOTE: This also applies to the Sysop games per day. In order to play the
  224.      maximum 99 games per day, with 9 hidden words per game, you would need 
  225.      901 words in the SEARCH.QUE file (which is also the limit for the file).
  226.          
  227.  
  228.         
  229.                                COM Support
  230.                                ___________
  231.  
  232.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  233.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  234.       number after the configuration filename. Let's assume your Door is
  235.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  236.       passed to your Door would be:
  237.                                    FOOBAR FOOBAR.CFG /5
  238.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  239.       normally used with COM1. No /x parameter is needed for the standard
  240.       IRQ's.
  241.  
  242.  
  243.  
  244.                                ADOPT-A-DOOR
  245.                                ____________
  246.  
  247.     Having been a Sysop for a number of years, I have had my share of problems
  248.     and frustrations getting financial support for my board's upkeep. A fellow
  249.     Sysop left a message on my board, not long ago, about a concept that was
  250.     being used by several boards around the country.
  251.  
  252.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  253.     would be the same as sending in a donation, only this way it is earmarked
  254.     for registering a particular door. In a way, the user feels he/she is
  255.     "getting something in return". As a Door author I have decided to build
  256.     this concept into each of my Door programs. The concept replaces the
  257.     usual message "tell the Sysop to register this Door" we find in most
  258.     doors.
  259.  
  260.     If the Door is unregisterd then a message appears on the opening screen
  261.     to that effect. After finishing or suspending a game, a message screen
  262.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  263.     caller to contact the Sysop to find out if there is any further details
  264.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  265.     time, etc to callers that ADOPT-A-DOOR.
  266.  
  267.     If the Door has been registered, either by the Sysop or other callers,
  268.     the names of those contributors will be displayed in the closing screen.
  269.  
  270.     NOTE: If you want to display the names of the callers that contributed
  271.           to registering the Door, you must create an ASCII file called
  272.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  273.           the name(s) of the contributors (one on each line, maximum of 5
  274.           entries, each a maximum of 30 characters long). This file must be
  275.           saved, in ASCII format, and placed in the Door directory.
  276.  
  277.  
  278.  
  279.                               LEGALITIES
  280.                               __________
  281.  
  282.  
  283.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  284.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  285.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  286.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  287.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  288.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  289.       OR BREACH OF ANY WARRANTY.
  290.  
  291.  
  292.  
  293.  
  294.  
  295.                              DISTRIBUTION
  296.                              ____________
  297.  
  298.    You may make this file available for downloading from your BBS or you may
  299.    upload it to any BBS of your choice, provided that you do not make any
  300.    changes to the contents of the archive (ZIP file). The archive and its
  301.    individual contents may not be used by any service that charges any money
  302.    whatsoever, without the written permission of the author.
  303.  
  304.  
  305.  
  306.  
  307.  
  308.                              REGISTRATION
  309.                              ____________
  310.  
  311.    Registration and the subsequent insertion of the registration number into
  312.    your configuation file, allows for the display of your BBS name on the
  313.    opening and closing screen as well as the reduction of a delay built into
  314.    the opening screen display along with the ability to change certain values
  315.    in the configuration file.
  316.  
  317.    To register your copy of SEARCH, please fill out the registration form
  318.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  319.    the name and address on the form.
  320.  
  321.    Be sure to use the proper upper/lower case when filling in your name and
  322.    BBS name, as they MUST match the way you entered them in the configuration
  323.    file.             ^^^^
  324.  
  325.    Based upon information supplied on the registration form, I will pre-
  326.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  327.    up your registration number.
  328.  
  329.  
  330.  
  331.                                  MISC
  332.                                  ____
  333.  
  334.    The latest version of WORD SEARCH and other fine SUNRISE DOOR programs
  335.    are always available for download from SUNRISE-80 BBS.
  336.  
  337.    Remember, should you have any problems, questions or suggestions, be sure
  338.    to drop me a message on Sunrise-80 or you can reach me through the
  339.    PCRELAY/RIME network in the BBS Doors, Sysops, PCBHints or through a R/O
  340.    to    ->SUNRISE
  341.  
  342.  
  343.